Skip to content

Trim verbose comments in the device YAML - #78

Merged
bharvey88 merged 2 commits into
betafrom
chore/trim-core-comments
Aug 28, 2026
Merged

Trim verbose comments in the device YAML#78
bharvey88 merged 2 commits into
betafrom
chore/trim-core-comments

Conversation

@bharvey88

@bharvey88 bharvey88 commented Aug 28, 2026

Copy link
Copy Markdown
Contributor

Version: 26.8.28.1

What does this implement/fix?

  • Trims the comment blocks in Core.yaml, CAST-1.yaml and wizmote.yaml to the non-obvious facts, and drops comments that restate the identifier below them
  • Moves the BT PSRAM comment into the sdkconfig block above CONFIG_BT_ALLOCATION_FROM_SPIRAM_FIRST, where it had been sitting above esp32_ble_tracker and reading as if it described the tracker
  • Rewords the resampler stack comment as a "must", since it guards the deliberate absence of task_stack_in_psram rather than a setting present in the file
  • Drops the commented-out decode_memory line, which parked a disabled option in the config
  • Removes the em dashes from all three device YAMLs

Comments only, no behavior change. esphome config validates.

Types of changes

  • Bugfix (fixed change that fixes an issue)
  • New feature (thanks!)
  • Breaking change (repair/feature that breaks existing functionality)
  • Dependency Update - Does not publish
  • Other - Does not publish
  • Website of github readme file update - Does not publish
  • Github workflows - Does not publish

Checklist / Checklijst:

  • The code change has been tested and works locally
  • The code change has not yet been tested

If user-visible functionality or configuration variables are added/modified:

  • Added/updated documentation for the web page

🤖 Generated with Claude Code

Cuts the comment blocks down to the non-obvious facts and drops comments
that restate the identifier below them.

Three corrections beyond the trim:

- Move the BT PSRAM comment into the sdkconfig block, above
  CONFIG_BT_ALLOCATION_FROM_SPIRAM_FIRST, instead of leaving it above
  esp32_ble_tracker where it read as describing the tracker.
- Reword the resampler stack comment as a "must", since it guards the
  deliberate absence of task_stack_in_psram rather than a setting present
  in the file.
- Drop the commented-out decode_memory line, which parked a disabled
  option in the config instead of stating a fact.

Comments only. esphome config validates unchanged.

🤖 Generated with [Claude Code](https://claude.com/claude-code)
@coderabbitai

coderabbitai Bot commented Aug 28, 2026

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 7163a2b9-1751-4bc1-8596-a173a0e9a65a


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Same pass as Core.yaml, applied to the other two device YAMLs.

CAST-1.yaml's header repeated the Ethernet preference that Core.yaml now
states at the network block; what is left names the file and points at
Core.yaml. wizmote.yaml's channel-scan block reduces to the rule it guards.

Comments only. esphome config validates unchanged.

🤖 Generated with [Claude Code](https://claude.com/claude-code)
@bharvey88 bharvey88 changed the title Trim verbose comments in Core.yaml Trim verbose comments in the device YAML Aug 28, 2026
@bharvey88
bharvey88 merged commit 0b34fb2 into beta Aug 28, 2026
6 checks passed
@bharvey88
bharvey88 deleted the chore/trim-core-comments branch August 28, 2026 16:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant